<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: syslog4cj.common.SyslogMessageProcessorIF Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">My Project
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacesyslog4cj.html">syslog4cj</a></li><li class="navelem"><a class="el" href="namespacesyslog4cj_1_1common.html">common</a></li><li class="navelem"><a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageProcessorIF.html">SyslogMessageProcessorIF</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="interfacesyslog4cj_1_1common_1_1SyslogMessageProcessorIF-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">syslog4cj.common.SyslogMessageProcessorIF Interface Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for syslog4cj.common.SyslogMessageProcessorIF:</div>
<div class="dyncontent">
 <div class="center">
  <img src="interfacesyslog4cj_1_1common_1_1SyslogMessageProcessorIF.png" usemap="#syslog4cj.common.SyslogMessageProcessorIF_map" alt=""/>
  <map id="syslog4cj.common.SyslogMessageProcessorIF_map" name="syslog4cj.common.SyslogMessageProcessorIF_map">
<area href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1AbstractSyslogMessageProcessor.html" alt="syslog4cj.impl.message.processor.AbstractSyslogMessageProcessor" shape="rect" coords="243,56,719,80"/>
<area href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1SyslogMessageProcessor.html" alt="syslog4cj.impl.message.processor.SyslogMessageProcessor" shape="rect" coords="0,112,476,136"/>
<area href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1structured_1_1StructuredSyslogMessageProcessor.html" alt="syslog4cj.impl.message.processor.structured.StructuredSyslogMessageProcessor" shape="rect" coords="486,112,962,136"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a1fb441085f922873564ab7410c2e7e30"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageProcessorIF.html#a1fb441085f922873564ab7410c2e7e30">createSyslogHeader</a> (Int64 facility, Int64 level, ?String localName, Bool sendLocalTimestamp, Bool sendLocalName):String</td></tr>
<tr class="separator:a1fb441085f922873564ab7410c2e7e30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac18e17543e5b2ce9cd2b709c579f9e66"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageProcessorIF.html#ac18e17543e5b2ce9cd2b709c579f9e66">createPacketData</a> (Array&lt; Byte &gt; header, Array&lt; Byte &gt; message, Int64 start, Int64 length):Array&lt; Byte &gt;</td></tr>
<tr class="separator:ac18e17543e5b2ce9cd2b709c579f9e66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90a3461d002fc33819d849f522cfcb0e"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageProcessorIF.html#a90a3461d002fc33819d849f522cfcb0e">createPacketData</a> (Array&lt; Byte &gt; header, Array&lt; Byte &gt; message, Int64 start, Int64 length, Array&lt; Byte &gt; splitBeginText, Array&lt; Byte &gt; splitEndText):Array&lt; Byte &gt;</td></tr>
<tr class="separator:a90a3461d002fc33819d849f522cfcb0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f1b7a6ef395c0d9f82bab8bf07e6554"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1common_1_1SyslogMessageProcessorIF.html#a1f1b7a6ef395c0d9f82bab8bf07e6554">createSyslogHeader</a> (Int64 facility, Int64 level, ?String localName, Bool sendLocalName, DateTime datetime):String</td></tr>
<tr class="separator:a1f1b7a6ef395c0d9f82bab8bf07e6554"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SyslogMessageProcessorIF 提供了一个可扩展的接口，用于编写自定义的 Syslog4j 消息处理器。 </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac18e17543e5b2ce9cd2b709c579f9e66" name="ac18e17543e5b2ce9cd2b709c579f9e66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac18e17543e5b2ce9cd2b709c579f9e66">&#9670;&#160;</a></span>createPacketData() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.common.SyslogMessageProcessorIF.createPacketData </td>
          <td>(</td>
          <td class="paramname"><em>header</em>:&#160;</td>
          <td class="paramtype">Array&lt;Byte&gt;, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>message</em>:&#160;</td>
          <td class="paramtype">Array&lt;Byte&gt;, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>start</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>length</em>:&#160;</td>
          <td class="paramtype">Int64&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>: Array&lt;Byte&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>创建数据包 </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">header</td><td>消息头 </td></tr>
    <tr><td class="paramname">message</td><td>消息内容 </td></tr>
    <tr><td class="paramname">start</td><td>起始位置 </td></tr>
    <tr><td class="paramname">length</td><td>消息长度 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>数据包 </dd></dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1AbstractSyslogMessageProcessor.html#a200b9772620e22600d8b48565ad58b5b">syslog4cj.impl.message.processor.AbstractSyslogMessageProcessor</a>.</p>

</div>
</div>
<a id="a90a3461d002fc33819d849f522cfcb0e" name="a90a3461d002fc33819d849f522cfcb0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90a3461d002fc33819d849f522cfcb0e">&#9670;&#160;</a></span>createPacketData() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.common.SyslogMessageProcessorIF.createPacketData </td>
          <td>(</td>
          <td class="paramname"><em>header</em>:&#160;</td>
          <td class="paramtype">Array&lt;Byte&gt;, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>message</em>:&#160;</td>
          <td class="paramtype">Array&lt;Byte&gt;, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>start</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>length</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>splitBeginText</em>:&#160;</td>
          <td class="paramtype">Array&lt;Byte&gt;, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>splitEndText</em>:&#160;</td>
          <td class="paramtype">Array&lt;Byte&gt;&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>: Array&lt;Byte&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>创建数据包 </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">header</td><td>消息头 </td></tr>
    <tr><td class="paramname">message</td><td>消息内容 </td></tr>
    <tr><td class="paramname">start</td><td>起始位置 </td></tr>
    <tr><td class="paramname">length</td><td>消息长度 </td></tr>
    <tr><td class="paramname">splitBeginText</td><td>分割开始文本 </td></tr>
    <tr><td class="paramname">splitEndText</td><td>分割结束文本 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>数据包 </dd></dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1AbstractSyslogMessageProcessor.html#ae89b9336a723a8faadaac58e7f218c34">syslog4cj.impl.message.processor.AbstractSyslogMessageProcessor</a>.</p>

</div>
</div>
<a id="a1f1b7a6ef395c0d9f82bab8bf07e6554" name="a1f1b7a6ef395c0d9f82bab8bf07e6554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f1b7a6ef395c0d9f82bab8bf07e6554">&#9670;&#160;</a></span>createSyslogHeader() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.common.SyslogMessageProcessorIF.createSyslogHeader </td>
          <td>(</td>
          <td class="paramname"><em>facility</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>level</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>localName</em>:&#160;</td>
          <td class="paramtype">?String, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>sendLocalName</em>:&#160;</td>
          <td class="paramtype">Bool, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>datetime</em>:&#160;</td>
          <td class="paramtype">DateTime&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>: String</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>创建Syslog消息头 </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">facility</td><td>facility值 </td></tr>
    <tr><td class="paramname">level</td><td>日志级别值 </td></tr>
    <tr><td class="paramname">localName</td><td>本地主机名 </td></tr>
    <tr><td class="paramname">sendLocalName</td><td>是否发送本地主机名 </td></tr>
    <tr><td class="paramname">datetime</td><td>日期时间 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Syslog消息头 </dd></dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1structured_1_1StructuredSyslogMessageProcessor.html#abec39b5e28c259515bf80964bce4ab76">syslog4cj.impl.message.processor.structured.StructuredSyslogMessageProcessor</a>, and <a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1SyslogMessageProcessor.html#af1d40ee70e9ca6a8a1df1221b8c1609c">syslog4cj.impl.message.processor.SyslogMessageProcessor</a>.</p>

</div>
</div>
<a id="a1fb441085f922873564ab7410c2e7e30" name="a1fb441085f922873564ab7410c2e7e30"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1fb441085f922873564ab7410c2e7e30">&#9670;&#160;</a></span>createSyslogHeader() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.common.SyslogMessageProcessorIF.createSyslogHeader </td>
          <td>(</td>
          <td class="paramname"><em>facility</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>level</em>:&#160;</td>
          <td class="paramtype">Int64, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>localName</em>:&#160;</td>
          <td class="paramtype">?String, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>sendLocalTimestamp</em>:&#160;</td>
          <td class="paramtype">Bool, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>sendLocalName</em>:&#160;</td>
          <td class="paramtype">Bool&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>: String</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>创建Syslog消息头 </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">facility</td><td>facility值 </td></tr>
    <tr><td class="paramname">level</td><td>日志级别值 </td></tr>
    <tr><td class="paramname">localName</td><td>本地主机名 </td></tr>
    <tr><td class="paramname">sendLocalTimestamp</td><td>是否发送本地时间戳 </td></tr>
    <tr><td class="paramname">sendLocalName</td><td>是否发送本地主机名 </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Syslog消息头 </dd></dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1structured_1_1StructuredSyslogMessageProcessor.html#a6b5ede093e5a6f29db5773892deb2252">syslog4cj.impl.message.processor.structured.StructuredSyslogMessageProcessor</a>, and <a class="el" href="classsyslog4cj_1_1impl_1_1message_1_1processor_1_1SyslogMessageProcessor.html#a65b594cf40c6ba7d4257844681c75d6a">syslog4cj.impl.message.processor.SyslogMessageProcessor</a>.</p>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/common/<a class="el" href="syslog__message__processor__if_8cj.html">syslog_message_processor_if.cj</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
